Skip to content

internal(Docs): Add script to detect broken links in the charts repository)#2205

Merged
monica-m-ps merged 10 commits intomainfrom
DOC-4871-add-script-to-detect-broken-links-in-the-charts-repository
Apr 1, 2025
Merged

internal(Docs): Add script to detect broken links in the charts repository)#2205
monica-m-ps merged 10 commits intomainfrom
DOC-4871-add-script-to-detect-broken-links-in-the-charts-repository

Conversation

@monica-m-ps
Copy link
Copy Markdown
Collaborator

@monica-m-ps monica-m-ps commented Mar 31, 2025

What this PR does / why we need it:

This PR detects broken links to docs.sysdig.com.

Checklist

  • Title of the PR starts with type and scope, (e.g. feat(agent,node-analyzer,sysdig-deploy):)
  • Chart Version bumped for the respective charts
  • Variables are documented in the README.md (or README.tpl in some charts)
  • Check GithubAction checks (like lint) to avoid merge-check stoppers
  • All test files are added in the tests folder of their respective chart and have a "_test" suffix

@monica-m-ps monica-m-ps self-assigned this Mar 31, 2025
Comment thread .gitignore Outdated
Comment thread scripts/docs-links-checker/check_docs_links.py Outdated
Comment thread .gitignore Outdated
@francesco-furlan
Copy link
Copy Markdown
Contributor

I would add also a github action (and a new required check) that runs for each PR and check if there are any broken links in the changed files.
@mavimo @aroberts87 WDYT?

Copy link
Copy Markdown
Contributor

@francesco-furlan francesco-furlan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
I synced with @mavimo and as a first step this will be a manual operation, and once we have enough confidence it will be ported to CI

@monica-m-ps
Copy link
Copy Markdown
Collaborator Author

Hey @francesco-furlan yes that's right. I have added it to the UI repo as well. Once I'm confident, I'll ask for help to add it to the ci/cd pipeline. :)

@monica-m-ps monica-m-ps merged commit 6196d14 into main Apr 1, 2025
5 checks passed
@monica-m-ps monica-m-ps deleted the DOC-4871-add-script-to-detect-broken-links-in-the-charts-repository branch April 1, 2025 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants